SIOPv2 OpenId4VP/eu.europa.ec.eudi.openid4vp

Package-level declarations

Types

AuthorizationRequestError

sealed interface AuthorizationRequestError : Serializable

Errors that can occur while validating and resolving an authorization request

AuthorizationRequestException

data class AuthorizationRequestException(val error: AuthorizationRequestError) : RuntimeException

An exception indicating an expected error while validating and/or resolving an authorization request

AuthorizationRequestResolver

fun interface AuthorizationRequestResolver

An interface that describes a service that accepts an authorization requestauthorization request, validates it and resolves it (that is, fetches parts of the authorization request which are provided by reference)

Base64UrlSafe

typealias Base64UrlSafe = String

Client

sealed interface Client : Serializable

Represents an OAuth2 RP that submitted an Authorization Request.

ClientIdPrefix

enum ClientIdPrefix : Enum<ClientIdPrefix>

Consensus

sealed interface Consensus : Serializable

Representation of holder's consensus to a ResolvedRequestObject

CoseAlgorithm

@JvmInline

@Serializable

value class CoseAlgorithm(val value: Int) : Serializable

Dispatcher

interface Dispatcher

This interface assembles an appropriate authorization response given a request and holder's consensus and then dispatches it to the verifier

DispatchOutcome

sealed interface DispatchOutcome : Serializable

The outcome of dispatching an Consensus to verifier/RP.

EncryptionParameters

sealed interface EncryptionParameters : Serializable

EncryptionRequirement

sealed interface EncryptionRequirement : Serializable

Wallet articulated encryption requirements.

ErrorDispatchDetails

data class ErrorDispatchDetails(val responseMode: ResponseMode, val nonce: String?, val state: String?, val clientId: VerifierId?, val responseEncryptionSpecification: ResponseEncryptionSpecification?) : Serializable

Information required for an AuthorizationRequestError to be dispatchable.

ErrorDispatcher

interface ErrorDispatcher

This interface assembles an appropriate authorization error response given an error that occurred during the authorization request resolution and then dispatches it to the verifier

ErrorDispatchPolicy

enum ErrorDispatchPolicy : Enum<ErrorDispatchPolicy> , Serializable

Wallets policy regarding error dispatching.

Format

@Serializable

@JvmInline

value class Format(val value: String)

HashAlgorithm

@JvmInline

value class HashAlgorithm(val name: String) : Serializable

IANA registered Hash Algorithms

HttpError

data class HttpError(val cause: Throwable) : AuthorizationRequestError

IdTokenType

enum IdTokenType : Enum<IdTokenType>

The type of the id_token the client (verifier party) requested

JarConfiguration

data class JarConfiguration(val supportedAlgorithms: List<JWSAlgorithm>, val supportedRequestUriMethods: SupportedRequestUriMethods = SupportedRequestUriMethods.Default)

Options related to JWT-Secured authorization requests

JwkSetSource

sealed interface JwkSetSource

Jwt

typealias Jwt = String

LookupPublicKeyByDIDUrl

fun interface LookupPublicKeyByDIDUrl

NonceOption

sealed interface NonceOption

OpenId4VPSpec

object OpenId4VPSpec

OpenId For Verifiable presentations

OriginalClientId

typealias OriginalClientId = String

The Original Client Id of a Verifier, i.e. without a Client Id Prefix.

PreregisteredClient

data class PreregisteredClient(val clientId: OriginalClientId, val legalName: String, val jarConfig: Pair<JWSAlgorithm, JwkSetSource>? = null)

The out-of-band knowledge of a Verifier, used in SupportedClientIdPrefix.Preregistered

RequestValidationError

sealed interface RequestValidationError : AuthorizationRequestError

Validation errors that can occur while validating an authorization request

Resolution

sealed interface Resolution

The outcome of validating and resolving an authorization request.

ResolutionError

sealed interface ResolutionError : AuthorizationRequestError

Errors that can occur while resolving an authorization request

ResolvedRequestObject

sealed interface ResolvedRequestObject : Serializable

Represents an OAUTH2 authorization request. In particular either a SIOPv2 for id_token or a OpenId4VP for vp_token or a SIOPv2 combined with OpenID4VP

ResponseEncryptionConfiguration

sealed interface ResponseEncryptionConfiguration

Configurations options for encrypting an authorization response if requested by the verifier.

ResponseEncryptionSpecification

data class ResponseEncryptionSpecification(val encryptionAlgorithm: JWEAlgorithm, val encryptionMethod: EncryptionMethod, val recipientKey: JWK) : Serializable

The client's (verifier) requirement for authorization response encryption that can be fulfilled by the wallet.

ResponseMode

sealed interface ResponseMode : Serializable

Scope

@JvmInline

value class Scope

SiopOpenId4Vp

interface SiopOpenId4Vp : AuthorizationRequestResolver, Dispatcher, ErrorDispatcher

An interface providing support for handling an OAUTH2 request that represents either an SIOP authentication request, or an OpenId4VP authorization request or a combined SIOP & OpenId4VP request.

SiopOpenId4VPConfig

data class SiopOpenId4VPConfig(val issuer: Issuer? = SelfIssued, val jarConfiguration: JarConfiguration = JarConfiguration.Default, val responseEncryptionConfiguration: ResponseEncryptionConfiguration = NotSupported, val vpConfiguration: VPConfiguration, val clock: Clock = Clock.systemDefaultZone(), val jarClockSkew: Duration = Duration.ofSeconds(15L), val supportedClientIdPrefixes: List<SupportedClientIdPrefix>, val errorDispatchPolicy: ErrorDispatchPolicy = ErrorDispatchPolicy.OnlyAuthenticatedClients)

Wallet configuration options for SIOP & OpenId4VP protocols.

SIOPv2

object SIOPv2

SubjectSyntaxType

sealed interface SubjectSyntaxType : Serializable

SupportedClientIdPrefix

sealed interface SupportedClientIdPrefix

The Client identifier prefix supported (or trusted) by the wallet.

SupportedRequestUriMethods

sealed interface SupportedRequestUriMethods

Which of the request_uri_method are supported by the wallet

SupportedTransactionDataType

sealed interface SupportedTransactionDataType

A type of Transaction Data supported by the Wallet.

TransactionData

sealed interface TransactionData : Serializable

Represents resolved (i.e., supported by the Wallet) Transaction Data.

TransactionDataType

@JvmInline

value class TransactionDataType(val value: String) : Serializable

VerifiablePresentation

sealed interface VerifiablePresentation

VerifiablePresentations

@JvmInline

value class VerifiablePresentations(val value: Map<QueryId, List<VerifiablePresentation>>)

VerifierId

data class VerifierId(val prefix: ClientIdPrefix, val originalClientId: OriginalClientId)

The Client Id of a Verifier as defined by OpenId4Vp.

VerifierInfo

@JvmInline

value class VerifierInfo(val attestations: List<VerifierInfo.Attestation>) : Serializable

VPConfiguration

data class VPConfiguration(val knownDCQLQueriesPerScope: Map<String, DCQL> = emptyMap(), val vpFormatsSupported: VpFormatsSupported, val supportedTransactionDataTypes: List<SupportedTransactionDataType> = emptyList())

Configuration options for OpenId4VP

VpFormatsSupported

@Serializable

data class VpFormatsSupported(val sdJwtVc: VpFormatsSupported.SdJwtVc? = null, val msoMdoc: VpFormatsSupported.MsoMdoc? = null) : Serializable

X509CertificateTrust

fun interface X509CertificateTrust

Functions

asException

fun AuthorizationRequestError.asException(): AuthorizationRequestException

Convenient method that lifts an AuthorizationRequestError into a AuthorizationRequestException

asFailure

fun <T> AuthorizationRequestError.asFailure(): Result<T>

Convenient method that lifts an AuthorizationRequestError into Result context (wrapping an AuthorizationRequestException)

legalName

fun X509Certificate.legalName(): String?

Gets the legal name (i.e., CN) from this X509Certificate.

fun Client.legalName(legalName: X509Certificate.() -> String? = X509Certificate::legalName): String?

Gets the legal name of this Client.